/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package org.xhy.sniffer.datacarrier.consumer;

import java.util.List;
import java.util.Properties;

public interface IConsumer<T> {
    /**
     * 初始化消费者实例，传入配置属性。
     *
     * @param properties 用于初始化消费者的配置。
     */
    void init(final Properties properties);

    /**
     * 消费从队列中获取到的数据。
     *
     * @param data 从队列中获取到的要处理的数据列表。
     */
    void consume(List<T> data);

    /**
     * 当消费过程中发生错误时，处理异常。
     *
     * @param data 出现错误时未成功处理的数据列表。
     * @param t 发生的异常。
     */
    void onError(List<T> data, Throwable t);

    /**
     * 在消费者即将退出时执行清理或关闭操作。
     */
    void onExit();

    /**
     * 当从队列中没有获取到数据时通知消费者。
     * 这个方法可以作为计时器，触发一些反应，例如队列中没有元素时采取某种行为。
     */
    default void nothingToConsume() {
        return; // 默认实现为空，可以被具体实现类覆盖。
    }
}

